/*
 * Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.truffle.espresso.shared.verifier;

import java.io.Serial;

/**
 * Indicates that bytecode verification rejected a method, with {@link VerificationException#kind()}
 * alluding to why verification failed.
 * <p>
 * The {@link #getMessage() message} of this exception provides a brief explanation of what caused
 * this failed.
 */
public class VerificationException extends Exception {
    @Serial private static final long serialVersionUID = 7039576945173150725L;

    /**
     * Indicates what the runtime should throw in response to a {@link VerificationException}.
     */
    public enum Kind {
        /** Corresponds to {@link VerifyError}. */
        Verify,
        /** Corresponds to {@link ClassFormatError}. */
        ClassFormat,
    }

    private final Kind kind;
    private final boolean allowFallback;

    VerificationException(String message, Kind kind) {
        this(message, kind, true);
    }

    VerificationException(String message, Kind kind, boolean allowFallback) {
        super(message);
        this.kind = kind;
        this.allowFallback = allowFallback;
    }

    public Kind kind() {
        return kind;
    }

    boolean allowFallback() {
        return allowFallback;
    }
}
